* GDK_DISABLE_DEPRECATION_WARNINGS:
*
* A macro that should be defined before including the gdk.h header.
+ *
* If it is defined, no compiler warnings will be produced for uses
* of deprecated GDK APIs.
*/
* This function takes into account device offsets that might be
* set with cairo_surface_set_device_offset().
*
- * Returns: A `cairo_region_t`; must be freed with cairo_region_destroy()
+ * Returns: (transfer full): A `cairo_region_t`
*/
cairo_region_t *
gdk_cairo_region_create_from_surface (cairo_surface_t *surface)
* draw context.
*
* `GdkCairoContext`s are created for a surface using
- * [method@Gdk.Surface.create_cairo_context], and the context can then be used
- * to draw on that surface.
+ * [method@Gdk.Surface.create_cairo_context], and the context
+ * can then be used to draw on that surface.
*/
typedef struct _GdkCairoContextPrivate GdkCairoContextPrivate;
* The returned context is guaranteed to be valid until
* [method@Gdk.DrawContext.end_frame] is called.
*
- * Returns: (transfer full) (nullable): a Cairo context to be used
- * to draw the contents of the `GdkSurface`. %NULL is returned
- * when @context is not drawing.
+ * Returns: (transfer full) (nullable): a Cairo context
+ * to draw on `GdkSurface
*/
cairo_t *
gdk_cairo_context_cairo_create (GdkCairoContext *self)
/**
* gdk_clipboard_store_async:
* @clipboard: a `GdkClipboard`
- * @io_priority: the I/O priority of the request.
- * @cancellable: (nullable): optional `GCancellable` object, %NULL to ignore.
+ * @io_priority: the I/O priority of the request
+ * @cancellable: (nullable): optional `GCancellable` object
* @callback: (scope async): callback to call when the request is satisfied
* @user_data: (closure): the data to pass to callback function
*
* @clipboard: a `GdkClipboard`
* @mime_types: a %NULL-terminated array of mime types to choose from
* @io_priority: the I/O priority of the request
- * @cancellable: (nullable): optional `GCancellable` object, %NULL to ignore.
+ * @cancellable: (nullable): optional `GCancellable` object
* @callback: (scope async): callback to call when the request is satisfied
* @user_data: (closure): the data to pass to callback function
*
* gdk_clipboard_read_finish:
* @clipboard: a `GdkClipboard`
* @result: a `GAsyncResult`
- * @out_mime_type: (out) (optional) (transfer none): pointer to store
+ * @out_mime_type: (out) (optional) (transfer none): location to store
* the chosen mime type
* @error: a `GError` location to store the error occurring
*
/**
* gdk_clipboard_read_text_async:
* @clipboard: a `GdkClipboard`
- * @cancellable: (nullable): optional `GCancellable` object, %NULL to ignore
+ * @cancellable: (nullable): optional `GCancellable` object
* @callback: (scope async): callback to call when the request is satisfied
* @user_data: (closure): the data to pass to callback function
*
* gdk_content_deserializer_get_gtype:
* @deserializer: a `GdkContentDeserializer`
*
- * Gets the GType to create an instance of.
+ * Gets the `GType` to create an instance of.
*
- * Returns: the GType for the current operation
+ * Returns: the `GType` for the current operation
*/
GType
gdk_content_deserializer_get_gtype (GdkContentDeserializer *deserializer)
*
* Gets the input stream for the current operation.
*
- * This is the stream that was passed to [func@content_deserialize_async].
+ * This is the stream that was passed to [func@Gdk.content_deserialize_async].
*
* Returns: (transfer none): the input stream for the current operation
*/
*
* Gets the I/O priority for the current operation.
*
- * This is the priority that was passed to [funccontent_deserialize_async].
+ * This is the priority that was passed to [func@Gdk.content_deserialize_async].
*
* Returns: the I/O priority for the current operation
*/
*
* Gets the cancellable for the current operation.
*
- * This is the `GCancellable` that was passed to [func@content_deserialize_async].
+ * This is the `GCancellable` that was passed to [func@Gdk.content_deserialize_async].
*
* Returns: (transfer none): the cancellable for the current operation
*/
* indicate a higher priority.
*
* When the operation is finished, @callback will be called. You must then
- * call [func@content_deserialize_finish] to get the result of the operation.
+ * call [func@Gdk.content_deserialize_finish] to get the result of the operation.
*/
void
gdk_content_deserialize_async (GInputStream *stream,
* If @string is not a valid mime type, %NULL is returned instead.
* See RFC 2048 for the syntax if mime types.
*
- * Returns: An interned string for the canonicalized mime type
- * or %NULL if the string wasn't a valid mime type
+ * Returns: (nullable): An interned string for the canonicalized
+ * mime type or %NULL if the string wasn't a valid mime type
*/
const char *
gdk_intern_mime_type (const char *string)
*
* The mime types must be valid and different from each other or the
* behavior of the return value is undefined. If you cannot guarantee
- * this, use `GdkContentFormatsBuilder` instead.
+ * this, use [struct@Gdk.ContentFormatsBuilder] instead.
*
* Returns: (transfer full): the new `GdkContentFormats`.
*/
*
* GTK provides serializers and deserializers for common data types
* such as text, colors, images or file lists. To register your own
- * serialization functions, use [func@content_register_serializer].
+ * serialization functions, use [func@Gdk.content_register_serializer].
*
* Also see [class@Gdk.ContentDeserializer].
*/
* indicate a higher priority.
*
* When the operation is finished, @callback will be called. You must then
- * call [func@content_serialize_finish] to get the result of the operation.
+ * call [func@Gdk.content_serialize_finish] to get the result of the operation.
*/
void
gdk_content_serialize_async (GOutputStream *stream,
projects / gtk4.git / commitdiff